pp108 : Tree (Objects)

Tree (Objects)


The Tree control can be used to represent data in a tree list. The control is associated with a schema that defines how data is displayed in the tree. Only the data that is compliant with the defined schema is displayed.

This control is derived from the AJAX Toolkit library - Tree. For details about the control's behavior and functionality, see Tree.

Properties, Events, and Methods of the Control


The properties, events, and methods associated with the Tree control define its behavior. You can set them either through the control's property sheet or programmatically using the APIs. For details, see Tree.

The following XForms-related properties and methods are available for the control:

Table 1. List of Properties

Design-time property

Run-time property

Description

ID

Sets the string that identifies the control on an XForm. If not specified, a unique ID is automatically generated.

Class Name

className

Sets or retrieves the class name applied on the control.

Model

Sets the ID of the data model from which the data (specified using the Reference property) is displayed in the control. If model is not specified, it is inherited from the parent control's model.

businessObject

Retrieves the root node of the XML data associated with the control; the location of the data is specified by the Reference property.

Table 2. List of Methods

Method

Description

addListener(sEventName, fpFunction)

This method registers a function to an event, such that the function gets called when the event is fired on the control.

disable()

This method disables the control on which it is invoked.

enable()

This method enables the control on which it is invoked.

getBusinessObject()

This method retrieves data or business object.

hide()

This method hides controls and all associated child controls.

isEnabled()

This method retrieves the value that denotes whether the control is enabled or not.

rebind(oBusinessObject)

This method is available for controls bound to a model. It refreshes the control with data from the business object that is passed as a parameter. If no parameter is passed, the business object of the model'sactiveTuplenode is used to refresh the control.

removeListener(sEventName, fpFunction)

This method unregisters a function from an event, such that the function stops getting called when the event is fired on the control.

show()

This method makes the control and its child controls visible.